/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.gui.model;

import java.util.ArrayList;
import java.util.List;

import kameleon.exception.KameleonException;
import kameleon.plugin.PlugInManager;

/**
 * Base model for the graphical interface. Handles the observers.
 * 
 * @author		Fromentin Xavier, Schnell Michaël
 * @version		1.0
 * 
 * @see			kameleon.gui.model.Observer
 */
public class Observable extends PlugInManager {
    
	/**
	 * List of all the known observers.
	 */
    protected List<Observer> observers ;

    /**
	 * Builds an instance with the given options.
	 * 
	 * @param	debugMode
	 * 			flag indicating if the debug mode should be activated
	 * 			({@code true} means activated)
	 */
    public Observable(boolean debugMode) {
        super(debugMode) ;
        this.observers = new ArrayList<Observer>() ;
    }// Observable()
    
    /**
	 * Builds an instance with the default options.
	 */
    public Observable() {
		this(DEFAULT_DEBUG_MODE) ;
	}// Observable()
    
    /**
     * Notifies the observers that the display language of the
     * graphical interface has changed. Invokes the method
     * {@link Observer#reloadLanguage()} on each observer.
     * 
     * @throws 	KameleonException
     * 			if an error occurred while changing the displayed 
     * 			language
     */
    public synchronized void notifyLanguageChange() throws KameleonException {
        for(Observer obs : this.observers) {
            obs.reloadLanguage();
        }// for
    }// notifyLanguageChange()
    
    /**
     * Notifies the observers that the model has changed. Invokes 
     * the method {@link Observer#update()} on each observer.
     * 
     * @throws 	KameleonException
     * 			if an error occurred while updating the observers
     */
    public synchronized void notifyObservers() throws KameleonException {
        for(Observer obs : this.observers) {
            obs.update() ;
        }// for
    }// notifyObservers()
    
    /**
     * Adds an observer to the list of known observers.
     * If the observer is already known, nothing is done.
     * To find the observer, the {@code equals} method
     * is used.
     * 
     * @param	newObs
     * 			new instance of {@code Observer}
     */
    public synchronized void addObserver(Observer newObs) {
        if (!this.observers.contains(newObs)) {
            this.observers.add(newObs) ;
        }// if
    }// addObserver(Observer)
    
    /**
     * Removes an observer from the list of known observers.
     * If the observer is not in the list, nothing is done.
     * To find the observer, the {@code equals} method
     * is used.
     * 
     * @param	oldObs
     * 			the deleted instance of {@code Observer}
     */
    public synchronized void removeObserver(Observer oldObs) {
        this.observers.remove(oldObs) ;
    }// removeObserver(Observer)
    
}// class Observable